（feat）因在#16pr中引入了uv包管理，修改readme中运行部分的命令#28
Open
akiooo45 wants to merge 2 commits intoembyplus:mainfrom
Open
Conversation
EmbyApi 的更新后的类图classDiagram
class EmbyApi {
-str emby_url
-str emby_api
-int timeout
+__init__(emby_url: str, emby_api: str, timeout: int = 10)
+async _request(method: str, path: str, data: dict = None, params: dict = None)
+async get_user(emby_id: str)
+async create_user(name: str)
+async ban_user(emby_id: str)
+async set_default_policy(emby_id: str)
+async update_user_policy(emby_id: str, policy_data: dict)
+async reset_user_password(emby_id: str)
+async set_user_password(emby_id: str, new_pass: str)
+async check_emby_site() bool
+async count()
}
note for EmbyApi "Uses aiohttp for asynchronous requests"
EmbyRouterAPI 的更新后的类图classDiagram
class EmbyRouterAPI {
-str api_url
-str api_key
-int timeout
+__init__(api_url: str, api_key: str = "", timeout: int = 10)
+async call_api(path: str)
+async query_all_route()
+async query_user_route(user_id: str)
+async update_user_route(user_id: str, new_index: str)
}
note for EmbyRouterAPI "Uses aiohttp for asynchronous requests"
文件级别更改
提示和命令与 Sourcery 交互
自定义您的体验访问您的 仪表板 以：
获取帮助Original review guide in EnglishReviewer's Guide by SourceryThis pull request migrates the project to use Sequence diagram for EmbyApi._request with aiohttpsequenceDiagram
participant Client
participant EmbyApi
participant aiohttp.ClientSession
participant EmbyServer
Client->>EmbyApi: _request(method, path, data, params)
activate EmbyApi
EmbyApi->>aiohttp.ClientSession: Create ClientSession with timeout
activate aiohttp.ClientSession
aiohttp.ClientSession-->>EmbyApi: ClientSession
deactivate aiohttp.ClientSession
EmbyApi->>aiohttp.ClientSession: session.request(method, url, params, json, headers)
activate aiohttp.ClientSession
aiohttp.ClientSession->>EmbyServer: HTTP Request (method, url, params, json, headers)
activate EmbyServer
EmbyServer-->>aiohttp.ClientSession: HTTP Response (status, body)
deactivate EmbyServer
alt response.status != 200
aiohttp.ClientSession-->>EmbyApi: Raise Exception
EmbyApi-->>Client: Exception
else response.status == 200
aiohttp.ClientSession-->>EmbyApi: response.json()
EmbyApi-->>Client: JSON Data
end
deactivate aiohttp.ClientSession
deactivate EmbyApi
Updated class diagram for EmbyApiclassDiagram
class EmbyApi {
-str emby_url
-str emby_api
-int timeout
+__init__(emby_url: str, emby_api: str, timeout: int = 10)
+async _request(method: str, path: str, data: dict = None, params: dict = None)
+async get_user(emby_id: str)
+async create_user(name: str)
+async ban_user(emby_id: str)
+async set_default_policy(emby_id: str)
+async update_user_policy(emby_id: str, policy_data: dict)
+async reset_user_password(emby_id: str)
+async set_user_password(emby_id: str, new_pass: str)
+async check_emby_site() bool
+async count()
}
note for EmbyApi "Uses aiohttp for asynchronous requests"
Updated class diagram for EmbyRouterAPIclassDiagram
class EmbyRouterAPI {
-str api_url
-str api_key
-int timeout
+__init__(api_url: str, api_key: str = "", timeout: int = 10)
+async call_api(path: str)
+async query_all_route()
+async query_user_route(user_id: str)
+async update_user_route(user_id: str, new_index: str)
}
note for EmbyRouterAPI "Uses aiohttp for asynchronous requests"
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
嘿 @akiooo45 - 我已经查看了你的更改 - 这里有一些反馈：
总体评论：
- 考虑添加一条注释，解释为什么你要从
requests切换到aiohttp。 - 看起来
EmbyApi和EmbyRouterAPI中的所有方法现在都可以是async。
以下是我在审查期间查看的内容
- 🟡 一般问题：发现 3 个问题
- 🟢 安全性：一切看起来都不错
- 🟢 测试：一切看起来都不错
- 🟡 复杂性：发现 1 个问题
- 🟢 文档：一切看起来都不错
帮助我更有用！请点击每个评论上的 👍 或 👎，我将使用反馈来改进您的评论。
Original comment in English
Hey @akiooo45 - I've reviewed your changes - here's some feedback:
Overall Comments:
- Consider adding a comment explaining why you're switching from
requeststoaiohttp. - It looks like all the methods in
EmbyApiandEmbyRouterAPIcan now beasync.
Here's what I looked at during the review
- 🟡 General issues: 3 issues found
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟡 Complexity: 1 issue found
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
| elif method.upper() == "POST": | ||
| response = requests.post( | ||
| url, params=params, json=data, timeout=self.timeout, headers=headers | ||
| async with aiohttp.ClientSession( |
There was a problem hiding this comment.
suggestion (performance): 考虑重用 ClientSession 以提高性能。
为每个请求创建一个新的 ClientSession 可能会导致不必要的开销和连接重建。根据使用模式，为类或应用程序的生命周期管理一个持久的 ClientSession 可能会有所帮助。
建议的实施方案：
def __init__(self, timeout):
self.timeout = timeout
# Create a persistent aiohttp ClientSession for reuse
self._session = aiohttp.ClientSession(timeout=aiohttp.ClientTimeout(total=self.timeout))
# any other initialization code try:
async with self._session.request(
method, url, params=params, json=data, headers=headers
) as response:
if response.status != 200:
raise Exception(
f"Request failed with status code {response.status}"
)
return await response.json()
except aiohttp.ClientError as e:由于 ClientSession 现在在初始化期间创建一次并且是持久的，因此您还应该添加一个方法，以便在您的类完成时关闭会话（例如，在关闭应用程序时）。
例如：
async def close(self):
await self._session.close()
您需要在应用程序生命周期的适当部分调用此 close() 方法。
Original comment in English
suggestion (performance): Consider reusing a ClientSession for performance.
Creating a new ClientSession for each request may lead to unnecessary overhead and connection re-establishment. Depending on the usage pattern, it might be beneficial to manage a persistent ClientSession for the lifetime of the class or application.
Suggested implementation:
def __init__(self, timeout):
self.timeout = timeout
# Create a persistent aiohttp ClientSession for reuse
self._session = aiohttp.ClientSession(timeout=aiohttp.ClientTimeout(total=self.timeout))
# any other initialization code try:
async with self._session.request(
method, url, params=params, json=data, headers=headers
) as response:
if response.status != 200:
raise Exception(
f"Request failed with status code {response.status}"
)
return await response.json()
except aiohttp.ClientError as e:Since the ClientSession is now created once during initialization and is persistent, you should also add a method to close the session when your class is done with it (for example, when shutting down the application).
For example:
async def close(self):
await self._session.close()
You'll need to call this close() method in the appropriate part of your application lifecycle.
| - 限时或限量开放注册。 | ||
|
|
||
| ### 安装及运行 | ||
| 本项目用[uv](https://github.com/astral-sh/uv)管理及运行 |
There was a problem hiding this comment.
suggestion (typo): “用”字后缺少冒号
“用”字后似乎应该有一个冒号，以提高可读性。它应该读作“本项目用：uv管理及运行”
Suggested change
| 本项目用[uv](https://github.com/astral-sh/uv)管理及运行 | |
| 本项目用：[uv](https://github.com/astral-sh/uv)管理及运行 |
Original comment in English
suggestion (typo): Missing colon after "用"
It seems like there should be a colon after the word "用" to improve readability. It should read as "本项目用：uv管理及运行"
Suggested change
| 本项目用[uv](https://github.com/astral-sh/uv)管理及运行 | |
| 本项目用：[uv](https://github.com/astral-sh/uv)管理及运行 |
| ### Thanks | ||
| - [Pyrogram](https://docs.pyrogram.org/) - Telegram API for Python | ||
| - [SQLAlchemy](https://www.sqlalchemy.org/) - Python SQL Toolkit and Object-Relational Mapping | ||
| - [Emby服管理bot by小草](https://github.com/xiaocao666tzh/EmbyBot) No newline at end of file |
There was a problem hiding this comment.
issue (typo): 缺少空格和损坏的链接
“Emby”和“服管理bot”之间应该有一个空格。此外，“No newline at end of file”之前的反斜杠破坏了链接。
Original comment in English
issue (typo): Missing space and broken link
There should be a space between "Emby" and "服管理bot". Also, the backslash before "No newline at end of file" is breaking the link.
| @@ -1,5 +1,6 @@ | |||
| import logging | |||
| import requests | |||
| import aiohttp | |||
There was a problem hiding this comment.
issue (complexity): 考虑将网络调用和错误处理逻辑提取到共享的帮助函数中，以减少代码重复。
考虑将网络调用和错误处理逻辑提取到共享的帮助函数中。例如，对于异步请求，您可以创建一个如下的助手：
```python
async def _fetch(session, method, url, *, headers=None, params=None, json=None):
try:
async with session.request(method, url, headers=headers, params=params, json=json) as response:
if response.status != 200:
raise Exception(f"Request failed with status code {response.status}")
return await response.json()
except aiohttp.ClientError as e:
logger.error(f"Client error during {method} {url}: {e}", exc_info=True)
raise Exception(f"请求路由服务时发生错误: {str(e)}")
except asyncio.TimeoutError:
logger.error(f"Request to {url} timed out", exc_info=True)
raise Exception("请求路由服务超时，请稍后重试或检查网络连接。")然后更新您的 call_api（和类似的方法）以使用它：
async def call_api(self, path: str):
url = f"{self.api_url}{path}"
headers = {"Authorization": f"Bearer {self.api_key}"} if self.api_key else {}
logger.debug(f"Calling API at {url}")
async with aiohttp.ClientSession(timeout=aiohttp.ClientTimeout(total=self.timeout)) as session:
return await _fetch(session, "GET", url, headers=headers)您可以类似地为您的同步请求创建带有 requests 的助手，以减少重复。这保持了功能完整，同时减少了重复的嵌套和 try/except 块。
<details>
<summary>Original comment in English</summary>
**issue (complexity):** Consider extracting the network call and error-handling logic into a shared helper function to reduce code duplication.
```markdown
Consider extracting the network call and error‐handling logic into a shared helper. For example, for asynchronous requests you can create a helper like:
```python
async def _fetch(session, method, url, *, headers=None, params=None, json=None):
try:
async with session.request(method, url, headers=headers, params=params, json=json) as response:
if response.status != 200:
raise Exception(f"Request failed with status code {response.status}")
return await response.json()
except aiohttp.ClientError as e:
logger.error(f"Client error during {method} {url}: {e}", exc_info=True)
raise Exception(f"请求路由服务时发生错误: {str(e)}")
except asyncio.TimeoutError:
logger.error(f"Request to {url} timed out", exc_info=True)
raise Exception("请求路由服务超时，请稍后重试或检查网络连接。")
Then update your call_api (and similar methods) to use it:
async def call_api(self, path: str):
url = f"{self.api_url}{path}"
headers = {"Authorization": f"Bearer {self.api_key}"} if self.api_key else {}
logger.debug(f"Calling API at {url}")
async with aiohttp.ClientSession(timeout=aiohttp.ClientTimeout(total=self.timeout)) as session:
return await _fetch(session, "GET", url, headers=headers)You can similarly create a helper for your synchronous requests with requests to reduce duplication. This keeps functionality intact while reducing the repeated nesting and try/except blocks.
</details>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
因在#16pr中引入了uv包管理，修改readme中运行部分的命令
好的，这是翻译成中文的 pull request 总结：
Sourcery 总结
更新项目以使用
uv包管理器，并切换到使用aiohttp的异步 HTTP 请求。更新 README，包含新的运行说明。增强功能：
requests库切换到aiohttp以进行异步 HTTP 请求文档：
uv包管理器的新安装和运行说明Original summary in English
Summary by Sourcery
Update the project to use the
uvpackage manager and switch to asynchronous HTTP requests usingaiohttp. Update the README with new run instructions.Enhancements:
requestslibrary toaiohttpfor making asynchronous HTTP requestsDocumentation:
uvpackage manager